/***************************************************************************//**
 * @file MSc_XmlDocument.h
 * @author  Marek M. Cel <marekcel@mscsim.org>
 *
 * @section LICENSE
 *
 * Copyright (C) 2014 Marek M. Cel
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/
#ifndef MSC_XML_DOCUMENT_H
#define MSC_XML_DOCUMENT_H

////////////////////////////////////////////////////////////////////////////////

#include <libxml/tree.h>

#include <MSc_Defs.h>

#include "MSc_XmlNode.h"

////////////////////////////////////////////////////////////////////////////////

/** */
class MSc_XmlDocument
{
public:

    /** Constrcutor. */
    MSc_XmlDocument();

    /** Destrcutor. */
    virtual ~MSc_XmlDocument();

    /** */
    inline MSc_XmlNode getRootNode()
    {
        return MSc_XmlNode( *m_root );
    }

    /** @return MSCFDM_SUCCESS on success, MSCFDM_FAILURE on failure. */
    int readFile( std::string fileName );

private:

    xmlDocPtr m_doc;

    MSc_XmlNode *m_root;
};

////////////////////////////////////////////////////////////////////////////////

#endif // MSC_XML_DOCUMENT_H
